package com.xy.webadmin.upms.service;



import com.xy.common.core.base.service.IBaseService;
import com.xy.webadmin.upms.model.MobileMenu;

import java.util.List;

/**
 * 移动端首页入口管理数据操作服务接口。
 *
 * @author 粒子互联
 * @date 2024-11-25
 */
public interface MobileMenuService extends IBaseService<MobileMenu, Long> {

    /**
     * 保存新增对象。
     *
     * @param mobileMenu      新增对象。
     * @param roleIdListString 逗号分隔的角色Id列表。
     * @return 返回新增对象。
     */
    MobileMenu saveNew(MobileMenu mobileMenu, String roleIdListString);

    /**
     * 更新数据对象。
     *
     * @param mobileMenu         更新的对象。
     * @param originalMobileMenu 原有数据对象。
     * @param roleIdListString    逗号分隔的角色Id列表。
     * @return 成功返回true，否则false。
     */
    boolean update(MobileMenu mobileMenu, MobileMenu originalMobileMenu, String roleIdListString);

    /**
     * 删除指定数据。
     *
     * @param menuId 主键Id。
     * @return 成功返回true，否则false。
     */
    boolean remove(Long menuId);

    /**
     * 获取单表查询结果。由于没有关联数据查询，因此在仅仅获取单表数据的场景下，效率更高。
     * 如果需要同时获取关联数据，请移步(getMobileMenuListWithRelation)方法。
     *
     * @param filter  过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<MobileMenu> getMobileMenuList(MobileMenu filter, String orderBy);

    /**
     * 获取主表的查询结果，以及主表关联的字典数据和一对一从表数据，以及一对一从表的字典数据。
     * 该查询会涉及到一对一从表的关联过滤，或一对多从表的嵌套关联过滤，因此性能不如单表过滤。
     * 如果仅仅需要获取主表数据，请移步(getMobileMenuList)，以便获取更好的查询性能。
     *
     * @param filter  主表过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<MobileMenu> getMobileMenuListWithRelation(MobileMenu filter, String orderBy);

    /**
     * 获取属于指定角色Id集合的移动端菜单列表。
     *
     * @param roleIds 逗号分隔的角色Id集合。
     * @return 移动端菜单对象列表。
     */
    List<MobileMenu> getMobileMenuListByRoleIds(String roleIds);
}
